

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Nyoka 5.0 &mdash; Scikit-Learn Exporter Module</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript">
          var DOCUMENTATION_OPTIONS = {
              URL_ROOT:'./',
              VERSION:'5.0',
              LANGUAGE:'None',
              COLLAPSE_INDEX:false,
              FILE_SUFFIX:'.html',
              HAS_SOURCE:  true,
              SOURCELINK_SUFFIX: '.txt'
          };
      </script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="statsmodels_to_pmml module" href="statsmodels_to_pmml.html" />
    <link rel="prev" title="retinanet module" href="retinanet.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> Nyoka
          

          
          </a>

          
            
            
              <div class="version">
                5.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
                <li class="toctree-l1"><a class="reference internal" href="statsmodels_to_pmml.html">Statsmodels Exporter Module</a></li>
                <li class="toctree-l1"><a class="reference internal" href="lgb_to_pmml.html">LightGBM Exporter Module</a></li>
                <li class="toctree-l1"><a class="reference internal" href="pre_process.html">Pre-Processing Exporter Module</a></li>
                <li class="toctree-l1 current"><a class="reference internal" href="skl_to_pmml.html">Scikit-Learn Exporter Module</a></li>
                <li class="toctree-l1"><a class="reference internal" href="xgboost_to_pmml.html">XGBoost Exporter Module</a></li>
                <li class="toctree-l1"><a class="reference internal" href="exponential_smoothing.html">ExponentialSmoothing Exporter Module</a></li>
                <li class="toctree-l1"><a class="reference internal" href="preprocess_nyoka.html">Nyoka's Pre-Processing Module</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Nyoka</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Scikit-Learn Exporter Module</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        <a href="https://github.com/SoftwareAG/nyoka" rel="nofollow" class="fa fa-github" aria-hidden="true"> Edit on GitHub</a>
      
    
  </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-skl_to_pmml">
<span id="skl-to-pmml-module"></span><h1>Scikit-Learn Exporter Module<a class="headerlink" href="#module-skl_to_pmml" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="skl_to_pmml.any_in">
<em class="property">def </em><code class="descname">any_in</code><span class="sig-paren">(</span><em>seq_a</em>, <em>seq_b</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#any_in"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.any_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks for common elements in two given sequence elements</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seq_a</strong> (<em>list</em>) – A list of items</li>
<li><strong>seq_b</strong> (<em>list</em>) – A list of items</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Returns a boolean value if any item of seq_a belongs to seq_b or visa versa</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.avgPathLength">
<em class="property">def </em><code class="descname">avgPathLength</code><span class="sig-paren">(</span><em>n</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#avgPathLength"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.avgPathLength" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates average path length for Isolation forest models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> (<em>int</em>) – Number of samples</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">The average path length</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_PMML_kwargs">
<em class="property">def </em><code class="descname">get_PMML_kwargs</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_PMML_kwargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_PMML_kwargs" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns all the pmml elements.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> (<em>Scikit-learn model object</em>) – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the target column .</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>algo_kwargs</strong> – Get the PMML model argument based on scikit learn model object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Dictionary</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_anomaly_detection_output">
<em class="property">def </em><code class="descname">get_anomaly_detection_output</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_anomaly_detection_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_anomaly_detection_output" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates output for anomaly detection models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – Scikit-learn’s model object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns Nyoka’s Output object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">output_fields</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_anomalydetection_model">
<em class="property">def </em><code class="descname">get_anomalydetection_model</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_anomalydetection_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_anomalydetection_model" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates xml elements for anomaly detction models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>anomaly_detection_model</strong> – Returns Nyoka’s AnomalyDetectionModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_bayes_inputs">
<em class="property">def </em><code class="descname">get_bayes_inputs</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_bayes_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_bayes_inputs" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Bayes Input element of the naive bayes model .</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s BayesInput object.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bayes_inputs</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_bayes_output">
<em class="property">def </em><code class="descname">get_bayes_output</code><span class="sig-paren">(</span><em>model</em>, <em>target_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_bayes_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_bayes_output" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Bayes Output element of the model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s BayesOutput object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="PMML44.html#PMML44.BayesOutput" title="PMML44.BayesOutput">BayesOutput</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_classificationMethod">
<em class="property">def </em><code class="descname">get_classificationMethod</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_classificationMethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_classificationMethod" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Classification method name for SVM models.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – A Scikit-learn model instance.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Returns the classification method of the SVM model</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_cluster_num">
<em class="property">def </em><code class="descname">get_cluster_num</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_cluster_num"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_cluster_num" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns number of cluster for clustering models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – An instance of Scikit-learn model.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>model.n_clusters</strong> – Returns the number of clusters</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Integer</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_cluster_vals">
<em class="property">def </em><code class="descname">get_cluster_vals</code><span class="sig-paren">(</span><em>model</em>, <em>counts</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_cluster_vals"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_cluster_vals" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates cluster information for clustering models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – An instance of Scikit-learn model.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>cluster_flds</strong> – Returns Nyoka’s Cluster object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_clustering_flds">
<em class="property">def </em><code class="descname">get_clustering_flds</code><span class="sig-paren">(</span><em>col_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_clustering_flds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_clustering_flds" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates cluster fields for clustering models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>col_names</strong> – Contains list of feature/column names.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>clustering_flds</strong> – Returns Nyoka’s ClusteringField object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_clustering_model">
<em class="property">def </em><code class="descname">get_clustering_model</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_clustering_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_clustering_model" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for clustering models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>clustering_models</strong> – Returns Nyoka’s ClusteringModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_comp_measure">
<em class="property">def </em><code class="descname">get_comp_measure</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_comp_measure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_comp_measure" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates comparison measure information for clustering models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Returns Nyoka’s ComparisonMeasure object</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_comparison_measure">
<em class="property">def </em><code class="descname">get_comparison_measure</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_comparison_measure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_comparison_measure" title="Permalink to this definition">¶</a></dt>
<dd><p>It return the Comparison measure element for nearest neighbour model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – An instance of Scikit-learn model.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns Nyoka’s ComparisonMeasure object.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">comp_measure</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_data_dictionary">
<em class="property">def </em><code class="descname">get_data_dictionary</code><span class="sig-paren">(</span><em>model</em>, <em>feature_names</em>, <em>target_name</em>, <em>categoric_values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_data_dictionary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_data_dictionary" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Data Dictionary element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>feature_names</strong> (<em>List</em>) – Contains the list of feature/column name.</li>
<li><strong>target_name</strong> (<em>List</em>) – Name of the Target column.</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s DataDictionary object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">data_dict</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_dtype">
<em class="property">def </em><code class="descname">get_dtype</code><span class="sig-paren">(</span><em>feat_value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_dtype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_dtype" title="Permalink to this definition">¶</a></dt>
<dd><p>It return the data type of the value.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feat_value</strong> – Contains a value for finding the its data type.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Returns the respective data type of that value.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_ensemble_models">
<em class="property">def </em><code class="descname">get_ensemble_models</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_ensemble_models"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_ensemble_models" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elemenets for ensemble models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value.</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>mining_models</strong> – Returns Nyoka’s MiningModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_funct">
<em class="property">def </em><code class="descname">get_funct</code><span class="sig-paren">(</span><em>sk_model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_funct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_funct" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the activation fucntion for a neural network model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – A Scikit-learn model instance.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>a_fn</strong> – Returns the activation function.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">String</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_header">
<em class="property">def </em><code class="descname">get_header</code><span class="sig-paren">(</span><em>description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_header" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Header element of the pmml.</p>
<blockquote>
<div><dl class="docutils">
<dt>header :</dt>
<dd>Returns Nyoka’s Header object.</dd>
</dl>
</div></blockquote>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_inline_table">
<em class="property">def </em><code class="descname">get_inline_table</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_inline_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_inline_table" title="Permalink to this definition">¶</a></dt>
<dd><p>It Returns the Inline Table element of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – An instance of Scikit-learn model.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns Nyoka’s InlineTable object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="PMML44.html#PMML44.InlineTable" title="PMML44.InlineTable">InlineTable</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_inner_segments">
<em class="property">def </em><code class="descname">get_inner_segments</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>index</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_inner_segments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_inner_segments" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the segments of a Segmentation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>index</strong> (<em>Integer</em>) – The index of the estimator for the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>segments</strong> – Nyoka’s Segment object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_instance_fields">
<em class="property">def </em><code class="descname">get_instance_fields</code><span class="sig-paren">(</span><em>derived_col_names</em>, <em>target_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_instance_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_instance_fields" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Instance field element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s InstanceFields object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="PMML44.html#PMML44.InstanceFields" title="PMML44.InstanceFields">InstanceFields</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_kernel_type">
<em class="property">def </em><code class="descname">get_kernel_type</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_kernel_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_kernel_type" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the kernel type element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – A Scikit-learn model instance.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>kernel_kwargs</strong> – Get the respective kernel type of the SVM model.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Dictionary</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_knn_inputs">
<em class="property">def </em><code class="descname">get_knn_inputs</code><span class="sig-paren">(</span><em>col_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_knn_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_knn_inputs" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the KNN Inputs element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns Nyoka’s KNNInputs object.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="PMML44.html#PMML44.KNNInputs" title="PMML44.KNNInputs">KNNInputs</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_mining_func">
<em class="property">def </em><code class="descname">get_mining_func</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_mining_func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_mining_func" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the name of the mining function of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – A Scikit-learn model instance.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>func_name</strong> – Returns the function name of the model</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">String</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_mining_schema">
<em class="property">def </em><code class="descname">get_mining_schema</code><span class="sig-paren">(</span><em>model</em>, <em>feature_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_mining_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_mining_schema" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Mining Schema of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>feature_names</strong> (<em>List</em>) – Contains the list of feature/column name.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value.</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nyoka’s MiningSchema object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="PMML44.html#PMML44.MiningSchema" title="PMML44.MiningSchema">MiningSchema</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_model_kwargs">
<em class="property">def </em><code class="descname">get_model_kwargs</code><span class="sig-paren">(</span><em>model</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_model_kwargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_model_kwargs" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns all the model element for a specific model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>model_kwargs</strong> – Returns  function name, MiningSchema and Output of the sk_model object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Dictionary</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_multiple_model_method">
<em class="property">def </em><code class="descname">get_multiple_model_method</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_multiple_model_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_multiple_model_method" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the type of multiple model method for MiningModels.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – A Scikit-learn model instance</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">The multiple model method for a MiningModel.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_naiveBayesModel">
<em class="property">def </em><code class="descname">get_naiveBayesModel</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_naiveBayesModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_naiveBayesModel" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for naive bayes models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>naive_bayes_model</strong> – Returns Nyoka’s NaiveBayesModel</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_nearestNeighbour_model">
<em class="property">def </em><code class="descname">get_nearestNeighbour_model</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_nearestNeighbour_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_nearestNeighbour_model" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for nearest neighbour model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s NearestNeighborModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">nearest_neighbour_model</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_neural_layer">
<em class="property">def </em><code class="descname">get_neural_layer</code><span class="sig-paren">(</span><em>model</em>, <em>feature_names</em>, <em>target_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_neural_layer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_neural_layer" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Neural Layer and Neural Ouptput element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>feature_names</strong> (<em>List</em>) – Contains the list of feature/column name.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple">
<li><strong>all_neuron_layer</strong> (<em>List</em>) – Nyoka’s NeuralLayer object</li>
<li><em>neural_output_element</em> – Nyoka’s NeuralOutput object</li>
</ul>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_neural_models">
<em class="property">def </em><code class="descname">get_neural_models</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_neural_models"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_neural_models" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for neural network models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value.</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>neural_model</strong> – Nyoka’s NeuralNetwork object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_neuron_input">
<em class="property">def </em><code class="descname">get_neuron_input</code><span class="sig-paren">(</span><em>feature_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_neuron_input"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_neuron_input" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Neural Input element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feature_names</strong> (<em>List</em>) – Contains the list of feature/column name.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns Nyoka’s NeuralInput object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">neural_input_element</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_node">
<em class="property">def </em><code class="descname">get_node</code><span class="sig-paren">(</span><em>model</em>, <em>features_names</em>, <em>main_model=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_node" title="Permalink to this definition">¶</a></dt>
<dd><p>It return the Node element of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of the estimator of the tree object.</li>
<li><strong>features_names</strong> (<em>List</em>) – Contains the list of feature/column name.</li>
<li><strong>main_model</strong> – A Scikit-learn model instance.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Get all the underlying Nodes.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_outer_segmentation">
<em class="property">def </em><code class="descname">get_outer_segmentation</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_outer_segmentation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_outer_segmentation" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Segmentation element of a MiningModel.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nyoka’s Segmentation object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">segmentation</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_output">
<em class="property">def </em><code class="descname">get_output</code><span class="sig-paren">(</span><em>model</em>, <em>target_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_output" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the output element of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nyoka’s Output object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="PMML44.html#PMML44.Output" title="PMML44.Output">Output</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_output_for_clustering">
<em class="property">def </em><code class="descname">get_output_for_clustering</code><span class="sig-paren">(</span><em>values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_output_for_clustering"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_output_for_clustering" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates output for clustering models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – An instance of Scikit-learn model.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>output_fields</strong> – Returns Nyoka’s Output object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_reg_mining_models">
<em class="property">def </em><code class="descname">get_reg_mining_models</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_reg_mining_models"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_reg_mining_models" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates xml elements for multi-class linear models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>mining_model</strong> – Returns a Nyoka’s MiningModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_reg_tab_for_reg_mining_model">
<em class="property">def </em><code class="descname">get_reg_tab_for_reg_mining_model</code><span class="sig-paren">(</span><em>model</em>, <em>col_names</em>, <em>index</em>, <em>categorical_values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_reg_tab_for_reg_mining_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_reg_tab_for_reg_mining_model" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates Regression Table for multi-class linear models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>index</strong> (<em>int</em>) – </li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Returns Nyoka’s RegressionTable object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_regrs_models">
<em class="property">def </em><code class="descname">get_regrs_models</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_regrs_models"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_regrs_models" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for linear models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>regrs_models</strong> – Nyoka’s RegressionModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_regrs_tabl">
<em class="property">def </em><code class="descname">get_regrs_tabl</code><span class="sig-paren">(</span><em>model</em>, <em>feature_names</em>, <em>target_name</em>, <em>categoric_values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_regrs_tabl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_regrs_tabl" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Regression Table element of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>merge</strong> – Nyoka’s RegressionTable object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_segments">
<em class="property">def </em><code class="descname">get_segments</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_segments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_segments" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Segment element of a Segmentation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nyoka’s Segment object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">segments</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_segments_for_gbc">
<em class="property">def </em><code class="descname">get_segments_for_gbc</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_segments_for_gbc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_segments_for_gbc" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns list of Segments element of a Segmentation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>segments</strong> – Nyoka’s Segment object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_super_cls_names">
<em class="property">def </em><code class="descname">get_super_cls_names</code><span class="sig-paren">(</span><em>model_inst</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_super_cls_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_super_cls_names" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the set of Super class of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model_inst</strong> – Instance of the scikit-learn model</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>parents</strong> – Returns all the parent class of the model instance.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Set</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_supportVectorMachine">
<em class="property">def </em><code class="descname">get_supportVectorMachine</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_supportVectorMachine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_supportVectorMachine" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for support vector machine models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – A Scikit-learn model instance.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>support_vector_machines</strong> – Nyoka’s SupportVectorMachineModel object</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_supportVectorMachine_models">
<em class="property">def </em><code class="descname">get_supportVectorMachine_models</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_names</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_supportVectorMachine_models"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_supportVectorMachine_models" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for support vector machine models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_names</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>supportVector_models</strong> – Returns Nyoka’s SupportVectorMachineModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_targets">
<em class="property">def </em><code class="descname">get_targets</code><span class="sig-paren">(</span><em>model</em>, <em>target_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_targets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_targets" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Target element of the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s Target object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">targets</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_threshold">
<em class="property">def </em><code class="descname">get_threshold</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_threshold"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_threshold" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Threshold value for Naive Bayes models.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Returns the Threshold value</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_training_instances">
<em class="property">def </em><code class="descname">get_training_instances</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>target_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_training_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_training_instances" title="Permalink to this definition">¶</a></dt>
<dd><p>It returns the Training Instance element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – An instance of Scikit-learn model.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Returns Nyoka’s TrainingInstances object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="PMML44.html#PMML44.TrainingInstances" title="PMML44.TrainingInstances">TrainingInstances</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_tree_models">
<em class="property">def </em><code class="descname">get_tree_models</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>col_names</em>, <em>target_name</em>, <em>mining_imp_val</em>, <em>categoric_values</em>, <em>model_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_tree_models"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_tree_models" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates PMML elements for tree models</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> – Contains column names after preprocessing.</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the Target column.</li>
<li><strong>mining_imp_val</strong> (<em>tuple</em>) – Contains the mining_attributes,mining_strategy, mining_impute_value</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
<li><strong>model_name</strong> (<em>string</em>) – Name of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>tree_models</strong> – Nyoka’s TreeModel object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.get_vectorDictionary">
<em class="property">def </em><code class="descname">get_vectorDictionary</code><span class="sig-paren">(</span><em>model</em>, <em>derived_col_names</em>, <em>categoric_values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#get_vectorDictionary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.get_vectorDictionary" title="Permalink to this definition">¶</a></dt>
<dd><p>It return the Vector Dictionary element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – A Scikit-learn model instance.</li>
<li><strong>derived_col_names</strong> (<em>List</em>) – Contains column names after preprocessing.</li>
<li><strong>categoric_values</strong> (<em>tuple</em>) – Contains Categorical attribute names and its values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nyoka’s VectorDictionary object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="PMML44.html#PMML44.VectorDictionary" title="PMML44.VectorDictionary">VectorDictionary</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.has_target">
<em class="property">def </em><code class="descname">has_target</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#has_target"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.has_target" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks whether a given model has target or not</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – Scikit-learn’s model object</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Boolean value</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="skl_to_pmml.skl_to_pmml">
<em class="property">def </em><code class="descname">skl_to_pmml</code><span class="sig-paren">(</span><em>pipeline</em>, <em>col_names</em>, <em>target_name='target'</em>, <em>pmml_f_name='from_sklearn.pmml'</em>, <em>model_name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/skl_to_pmml.html#skl_to_pmml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#skl_to_pmml.skl_to_pmml" title="Permalink to this definition">¶</a></dt>
<dd><p>Exports scikit-learn pipeline object into pmml</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>pipeline</strong> – Contains an instance of Pipeline with preprocessing and final estimator</li>
<li><strong>col_names</strong> (<em>List</em>) – Contains list of feature/column names.</li>
<li><strong>target_name</strong> (<em>String</em>) – Name of the target column. (Default=’target’)</li>
<li><strong>pmml_f_name</strong> (<em>String</em>) – Name of the pmml file. (Default=’from_sklearn.pmml’)</li>
<li><strong>model_name</strong> (<em>string</em><em> (</em><em>optional</em><em>)</em>) – Name of the model</li>
<li><strong>description</strong> (<em>string</em><em> (</em><em>optional</em><em>)</em>) – Description of the model</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Generates a PMML object and exports it to <cite>pmml_f_name</cite></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="xgboost_to_pmml.html" class="btn btn-neutral float-right" title="XGBoost Exporter Module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="pre_process.html" class="btn btn-neutral float-left" title="Pre-Processing Exporter Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2021, maintainer@nyoka.org

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>